Description

TUnit already supports test artifacts via TestContext.Output.AttachArtifact() and TestSessionContext.AddArtifact(), but lacked documentation. Users migrating from NUnit were confused by the missing equivalent to TestContext.AddTestAttachment().

Added:

• Comprehensive artifacts guide (docs/docs/test-lifecycle/artifacts.md)

  • Test-level and session-level artifact APIs
  • Best practices: cleanup, organization, conditional attachment
  • Real-world examples: Playwright screenshots, API logs, database queries
  • CI/CD integration notes

• Updated test-context.md

  • Added "Test Output and Artifacts" section
  • Documented both Output.WriteLine() (interface-based) and OutputWriter.WriteLine() (direct TextWriter) patterns

• Updated migration guides (NUnit, MSTest, xUnit)

  • Mapped framework-specific attachment APIs to TUnit's Artifact class

Example usage:

// Test-level artifact
TestContext.Current!.Output.AttachArtifact(new Artifact
{
    File = new FileInfo("screenshot.png"),
    DisplayName = "Failure Screenshot",
    Description = "Screenshot captured when test failed"
});

// Session-level artifact
TestSessionContext.Current!.AddArtifact(new Artifact
{
    File = new FileInfo("test-session-log.txt"),
    DisplayName = "Test Session Log"
});

Related Issue

Fixes #4612

Type of Change

• Documentation update

Checklist

Required

• I have read the Contributing Guidelines
• If this is a new feature, I started a discussion first and received agreement
• My code follows the project's code style (modern C# syntax, proper naming conventions)
• I have written tests that prove my fix is effective or my feature works

TUnit-Specific Requirements

• Dual-Mode Implementation: N/A - documentation only
• Snapshot Tests: N/A - no code changes
• Performance: N/A - documentation only
• AOT Compatibility: N/A - documentation only

Testing

• All existing tests pass (dotnet test)
• I have added tests that cover my changes (N/A - existing TestArtifactTests.cs validates documented API)
• I have tested both source-generated and reflection modes (if applicable)

Additional Notes

Documentation builds successfully with Docusaurus. All internal links resolve correctly. Existing artifact test validates the documented API works as specified.

• Fixes [Feature]: Add support for test attachments #4073

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.